KFbxConstraintPosition Class Reference

#include <kfbxconstraintposition.h>

Inheritance diagram for KFbxConstraintPosition:

[legend]

List of all members.

---

Detailed Description

This constraint class contains methods for accessing the properties of a position constraint.

A position constraint lets you constrain the position of an object based on the position of one or more sources.

Definition at line 57 of file kfbxconstraintposition.h.

Properties
KFbxTypedProperty< fbxBool1 >	AffectX
	This property handles whether to affect x axis.
KFbxTypedProperty< fbxBool1 >	AffectY
	This property handles whether to affect y axis.
KFbxTypedProperty< fbxBool1 >	AffectZ
	This property handles whether to affect z axis.
KFbxTypedProperty< fbxDouble3 >	Translation
	This property handles translation offset.
KFbxTypedProperty< fbxReference >	ConstraintSources
	This property handles constraint source objects.
KFbxTypedProperty< fbxReference >	ConstrainedObject
	This property handles constraint target objects.
Public Member Functions
void	SetLock (bool pLock)
	Set the constraint lock.
bool	GetLock () const
	Retrieve the constraint lock state.
void	SetAffectX (bool pAffect)
	Set the constraint X-axis effectiveness.
bool	GetAffectX () const
	Retrieve the constraint X-axis effectiveness.
void	SetAffectY (bool pAffect)
	Set the constraint Y-axis effectiveness.
bool	GetAffectY () const
	Retrieve the constraint Y-axis effectiveness.
void	SetAffectZ (bool pAffect)
	Set the constraint Z-axis effectiveness.
bool	GetAffectZ () const
	Retrieve the constraint Z-axis effectiveness.
virtual void	SetOffset (KFbxVector4 pTranslation)
	Set the translation offset.
KFbxVector4	GetOffset () const
	Retrieve the constraint translation offset.
void	SetWeight (double pWeight)
	Set the weight of the constraint.
void	AddConstraintSource (KFbxObject *pObject, double pWeight=100)
	Add a source to the constraint.
bool	RemoveConstraintSource (KFbxObject *pObject)
	Remove a source from the constraint.
int	GetConstraintSourceCount () const
	Retrieve the constraint source count.
KFbxObject *	GetConstraintSource (int pIndex) const
	Retrieve a constraint source object.
void	SetConstrainedObject (KFbxObject *pObject)
	Set the constrained object.
KFbxObject *	GetConstrainedObject () const
	Retrieve the constrained object.

---

Member Function Documentation

void SetLock

(

bool

pLock

)

Set the constraint lock.

Parameters:

pLock

State of the lock flag.

bool GetLock

(

)

const

Retrieve the constraint lock state.

Returns:

Current lock flag.

void SetAffectX

(

bool

pAffect

)

Set the constraint X-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectX

(

)

const

Retrieve the constraint X-axis effectiveness.

Returns:

Current state flag.

void SetAffectY

(

bool

pAffect

)

Set the constraint Y-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectY

(

)

const

Retrieve the constraint Y-axis effectiveness.

Returns:

Current state flag.

void SetAffectZ

(

bool

pAffect

)

Set the constraint Z-axis effectiveness.

Parameters:

pAffect

State of the effectiveness on the X axis.

bool GetAffectZ

(

)

const

Retrieve the constraint Z-axis effectiveness.

Returns:

Current state flag.

virtual void SetOffset

(

KFbxVector4

pTranslation

)

[virtual]

Set the translation offset.

Parameters:

pTranslation

New offset vector.

Reimplemented from KFbxConstraint.

KFbxVector4 GetOffset

(

)

const

Retrieve the constraint translation offset.

Returns:

Current translation offset.

void SetWeight

(

double

pWeight

)

Set the weight of the constraint.

Parameters:

pWeight

New weight value.

void AddConstraintSource	(	KFbxObject *	pObject,
		double	pWeight = 100
	)

Add a source to the constraint.

Parameters:

	pObject	New source object.
	pWeight	Weight of the source object.

bool RemoveConstraintSource

(

KFbxObject *

pObject

)

Remove a source from the constraint.

Parameters:

pObject

Source object to remove.

int GetConstraintSourceCount

(

)

const [virtual]

Retrieve the constraint source count.

Returns:

Current constraint source count.

Reimplemented from KFbxConstraint.

KFbxObject* GetConstraintSource

(

int

pIndex

)

const [virtual]

Retrieve a constraint source object.

Parameters:

pIndex

Index of the source

Returns:

Current source at the specified index.

Reimplemented from KFbxConstraint.

void SetConstrainedObject

(

KFbxObject *

pObject

)

Set the constrained object.

Parameters:

pObject

The constrained object.

KFbxObject* GetConstrainedObject

(

)

const [virtual]

Retrieve the constrained object.

Returns:

Current constrained object.

Reimplemented from KFbxConstraint.

---

Member Data Documentation

KFbxTypedProperty<fbxBool1> AffectX

This property handles whether to affect x axis.

Default value is true.

Definition at line 71 of file kfbxconstraintposition.h.

KFbxTypedProperty<fbxBool1> AffectY

This property handles whether to affect y axis.

Default value is true.

Definition at line 77 of file kfbxconstraintposition.h.

KFbxTypedProperty<fbxBool1> AffectZ

This property handles whether to affect z axis.

Default value is true.

Definition at line 83 of file kfbxconstraintposition.h.

KFbxTypedProperty<fbxDouble3> Translation

This property handles translation offset.

Default value is (0, 0, 0).

Definition at line 89 of file kfbxconstraintposition.h.

KFbxTypedProperty<fbxReference> ConstraintSources

This property handles constraint source objects.

Definition at line 93 of file kfbxconstraintposition.h.

KFbxTypedProperty<fbxReference> ConstrainedObject

This property handles constraint target objects.

Definition at line 97 of file kfbxconstraintposition.h.